Various documentation improvements. #265
Conversation
| The `Complex` type is generic over an associated `RealType`; complex numbers | ||
| are represented as two `RealType` values, the real and imaginary parts of the | ||
| number. | ||
| ``` |
There was a problem hiding this comment.
For broader compatibility with various Markdown viewer implementations, would it be possible to add an extra line before and after such code blocks?
| let a: Double = 1 | ||
| let b = 2*a |
There was a problem hiding this comment.
I think it is easier to follow along the arithmetic examples (especially the next one), if this unsupported heterogeneous operator example would re-use the example from C above (and below) – I may be wrong.
| let a: Double = 1 | |
| let b = 2*a | |
| import ComplexModule | |
| let r: Double = 1.0 | |
| let z = Complex<Double>(0, 2) | |
| let w = r + z // ❌ |
There was a problem hiding this comment.
The point is to provide an example that would break if we did have a heterogeneous operator.
There was a problem hiding this comment.
You are right - my example is misleading. Does it make sense to adjust the other two examples then, and make them use multiplication over addition?
There was a problem hiding this comment.
I tried to rearrange stuff to clarify it a little bit, might revisit later.
stephentyrone
force-pushed
the
docc-stuff
branch
from
e77a36a to
5cc83cc
Compare
This is potentially useful to identify some bugs, but there are also algorithms (notably Kahan summation) that can be written in terms of fast2sum but would fail this check. Rework documentation to account for the change.
| @@ -12,26 +12,29 @@ | |||
| extension BinaryInteger { | |||
| /// `self` divided by `other`, rounding the result according to `rule`. | |||
There was a problem hiding this comment.
| /// `self` divided by `other`, rounding the result according to `rule`. | |
| /// Returns the result of dividing this value by `other`, rounding the result | |
| /// according to `rule`. |
or (preferred):
| /// `self` divided by `other`, rounding the result according to `rule`. | |
| /// Returns the result of dividing this value by the given value, rounding | |
| /// the result according to specified rule. |
| `ElementaryFunctions` (so all the usual math functions are | ||
| available). | ||
| A complex number type represented by its real and imaginary parts, and equipped | ||
| with the usual arithmetic operators and math functions. |
This commit _also_ relaxes the constraint on Augmented algorithms from Real to FloatingPoint. It's worth calling out that fastTwoSum does not work with decimal floating-point types, so the unordered `Augemented.sum(_:_:)` now has a radix check and calls into the ordered twoSum function instead for Decimal. This makes more sense that a `BinaryFloatingPoint` constraint, as otherwise generic code written against Real or FloatingPoint would have to do the check at every call site.
|
API break reported by tests is not actually an API break, because Real refines FloatingPoint (and we haven't yet tagged a release with those API anyway). |
Added some docc catalogs and articles, fixed a bunch of minor errors, all that good stuff. More work needed.